/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.ml.api.misc.param;

import org.apache.flink.annotation.PublicEvolving;

import java.io.Serializable;

/**
 * An interface used by {@link ParamInfo} to do validation when a parameter value is set.
 *
 * @param <V> the type of the value to validate
 */
@PublicEvolving
public interface ParamValidator<V> extends Serializable {
    /**
     * Validates a parameter value.
     *
     * @param value value to validate
     * @return {@code true} if the value is valid, {@code false} otherwise
     */
    boolean validate(V value);
}
